/**
 * Copyright (c) 2009 Teoti Graphix, LLC See:
 *     http://tkarchitecture.teotigraphix.org
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 * 
 * @author Michael Schmalle mschmalle@teotigraphix.com
 */
package org.teotigraphix.dx.core
{

import org.teotigraphix.dx.interfaces.IToolKitPhase;

/**
 * A toolkit phase with <code>phase</code> and <code>data</code>.
 * 
 * @copyright Teoti Graphix, LLC
 * @author Michael Schmalle
 * @date 08-24-09
 */
public final class ToolKitPhase 
	   implements IToolKitPhase
{
	//--------------------------------------------------------------------------
	//
	//  Public :: Constants
	//
	//--------------------------------------------------------------------------
		
	public static const CONSTRUCT:String = "construct";
	public static const PARENT_CHANGE:String = "parentChange";
	public static const STYLE_CHANGE:String = "styleChange";
	public static const STYLE_INITIALIZE:String = "styleInitialize";
	public static const INITIALIZE:String = "initialize";
	
	public static const SKIN_ATTATCHMENT:String = "skinAttachment";
	public static const CREATE_CHILDREN:String = "createChildren";
	public static const INITIALIZE_COMPLETE:String = "initializeComplete";

	public static const PROPERTIES:String = "properties";
	public static const MEASURE:String = "measure";
	public static const DISPLAY_LIST:String = "displayList";
	
	public static const SKIN_DETATCHMENT:String = "skinDetatchment";	
	
	//--------------------------------------------------------------------------
	//
	//  IToolKitPhase API :: Properties
	//
	//--------------------------------------------------------------------------
	
	//----------------------------------
	//  phase
	//----------------------------------
	
	/**
	 * @private
	 */
	private var _phase:String;

	/**
	 * Returns the current phase for the instance.
	 */
	public function get phase():String
	{
		return _phase;
	}
	
	//----------------------------------
	//  data
	//----------------------------------
	
	/**
	 * @private
	 */
	private var _data:Object;
	
	/**
	 * Returns the data passed along with the phase, usually this is a typed
	 * instance that can be cast when used.
	 */
	public function get data():Object
	{
		return _data;
	}
	
	//--------------------------------------------------------------------------
	//
	//  Constructor
	//
	//--------------------------------------------------------------------------
	
	/**
	 * Creates a new toolkit phase instance.
	 * 
	 * @param phase A string indicatin the current phase.
	 * @param data Phase data passed with the current phase.
	 */
	public function ToolKitPhase(phase:String, data:Object)
	{
		_phase = phase;
		_data = data;
	}
}
}